Skip to content

docs(monitoring): add tracing docs and OTLP setup guidance#1526

Open
SH20RAJ wants to merge 1 commit intomofa-org:mainfrom
SH20RAJ:docs/1269-monitoring-doc-gaps
Open

docs(monitoring): add tracing docs and OTLP setup guidance#1526
SH20RAJ wants to merge 1 commit intomofa-org:mainfrom
SH20RAJ:docs/1269-monitoring-doc-gaps

Conversation

@SH20RAJ
Copy link
Copy Markdown

@SH20RAJ SH20RAJ commented Mar 28, 2026

Adds missing documentation for core mofa-monitoring tracing APIs and README setup guidance.

What changed:

  • expanded rustdoc across tracing span/tracer modules for public enums and constructors
  • documented SamplingStrategy semantics and processor behavior
  • added tracing module quick-start usage example for AgentTracer
  • added OTLP environment variable guidance in README
  • added README AgentTracer integration snippet

This improves discoverability and onboarding for monitoring/tracing integration.

Closes #1269

@SH20RAJ
Copy link
Copy Markdown
Author

SH20RAJ commented Mar 29, 2026

Expanding documentation for the 'Cognitive Observatory' (GSoC Idea #2). This PR adds comprehensive setup guides for OTLP tracing and monitoring instrumentation. Clear documentation is essential for lowering the barrier to entry for enterprise contributors and ensuring MoFA's observability features are fully utilized. 📚

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Missing documentation for mofa-monitoring crate

1 participant